Skip to content

Conversation

@Delta456
Copy link
Member

@Delta456 Delta456 commented Jan 15, 2025

User description

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

Change line numbers so that the docs can focus on the main things

Motivation and Context

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

Documentation


Description

  • Updated line numbers in Java code examples across multiple documentation files.

  • Adjusted code block references to match updated Java test files.

  • Ensured consistency in documentation for Java examples in different languages.


Changes walkthrough 📝

Relevant files
Documentation
print_page.en.md
Adjust Java code block references in English documentation

website_and_docs/content/documentation/webdriver/interactions/print_page.en.md

  • Updated Java code block line numbers for multiple examples.
  • Adjusted references to match updated Java test files.
  • +9/-9     
    print_page.ja.md
    Adjust Java code block references in Japanese documentation

    website_and_docs/content/documentation/webdriver/interactions/print_page.ja.md

  • Updated Java code block line numbers for multiple examples.
  • Adjusted references to match updated Java test files.
  • +9/-9     
    print_page.pt-br.md
    Adjust Java code block references in Portuguese documentation

    website_and_docs/content/documentation/webdriver/interactions/print_page.pt-br.md

  • Updated Java code block line numbers for multiple examples.
  • Adjusted references to match updated Java test files.
  • +9/-9     
    print_page.zh-cn.md
    Adjust Java code block references in Chinese documentation

    website_and_docs/content/documentation/webdriver/interactions/print_page.zh-cn.md

  • Updated Java code block line numbers for multiple examples.
  • Adjusted references to match updated Java test files.
  • +9/-9     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @netlify
    Copy link

    netlify bot commented Jan 15, 2025

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit 8a83853

    @qodo-merge-pro
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    @qodo-merge-pro
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Fix inconsistent line number format in code block reference to ensure proper rendering

    Fix the malformed code block reference by adding the missing 'L' prefix in the line
    number specification.

    website_and_docs/content/documentation/webdriver/interactions/print_page.pt-br.md [95]

    -{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/interactions/PrintOptionsTest.java#41-L48" >}}
    +{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/interactions/PrintOptionsTest.java#L41-L48" >}}
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: The missing 'L' prefix in the line number specification could cause rendering issues or broken code block references, affecting documentation accuracy and user experience.

    8

    @harsha509 harsha509 merged commit 861cdfc into SeleniumHQ:trunk Jan 15, 2025
    2 checks passed
    selenium-ci added a commit that referenced this pull request Jan 15, 2025
    @Delta456 Delta456 deleted the java_print branch March 19, 2025 10:54
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants